Document TypeDescriptor method operations - #552
Conversation
Refs #201 Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
dalexsoto
left a comment
dalexsoto
left a comment
There was a problem hiding this comment.
InsertParameterTypes says descriptors are inserted before the parameter at pos, but API 34 permits pos == ParameterCount; in that case no parameter exists there and the descriptors are appended. Please say insertion starts at pos and explicitly document the append case: ITypeDescriptor+IOfMethod.xml.
Refs #201 Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
jonathanpeppers
left a comment
jonathanpeppers
left a comment
There was a problem hiding this comment.
Addressed in 3f2c925. InsertParameterTypes now says insertion starts at pos and explicitly documents that pos == ParameterCount() appends the supplied descriptors because no parameter exists at that position.
|
Addressed in 3f2c925: insertion starts at pos; when pos == ParameterCount(), the supplied descriptors are appended because no parameter exists at that position. |
There was a problem hiding this comment.
Pull request overview
Adds detailed XML documentation for the Android API 34 Java.Lang.Invoke.ITypeDescriptor.IOfMethod (“TypeDescriptor.OfMethod”) operations so the generated .NET API docs no longer contain To be added. placeholders for these members.
Changes:
- Replaced placeholder
<summary>,<param>,<returns>, and<remarks>text for sevenITypeDescriptor.IOfMethodmembers. - Added concise behavioral descriptions for descriptor-transforming and descriptor-inspecting operations.
Suppressed comments (6)
docs/xml/Java.Lang.Invoke/ITypeDescriptor+IOfMethod.xml:125
- These member docs add new prose but omit the standard Android reference link + AOSP/CC BY attribution paragraphs used elsewhere in this file (e.g., ParameterCount/ParameterList). For consistency and licensing attribution, please add the reference link for changeReturnType(...) and the attribution para to this block.
<remarks>
<para>The returned descriptor has the same parameter types as this descriptor and uses <paramref name="newReturn" /> as its return type.</para>
</remarks>
docs/xml/Java.Lang.Invoke/ITypeDescriptor+IOfMethod.xml:210
- These member docs add new prose but omit the standard Android reference link + AOSP/CC BY attribution paragraphs used elsewhere in this file (e.g., ParameterCount/ParameterList). For consistency and licensing attribution, please add the reference link for insertParameterTypes(...) and the attribution para to this block.
<remarks>
<para>Insertion starts at <paramref name="pos" />. When <paramref name="pos" /> equals <c>ParameterCount()</c>, the supplied field descriptors are appended because no parameter exists at that position.</para>
</remarks>
docs/xml/Java.Lang.Invoke/ITypeDescriptor+IOfMethod.xml:248
- These member docs add new prose but omit the standard Android reference link + AOSP/CC BY attribution paragraphs used elsewhere in this file (e.g., ParameterCount/ParameterList). For consistency and licensing attribution, please add the reference link for parameterArray() and the attribution para to this block.
<remarks>
<para>The returned array describes the parameter types in declaration order.</para>
</remarks>
docs/xml/Java.Lang.Invoke/ITypeDescriptor+IOfMethod.xml:369
- These member docs add new prose but omit the standard Android reference link + AOSP/CC BY attribution paragraphs used elsewhere in this file (e.g., ParameterCount/ParameterList). For consistency and licensing attribution, please add the reference link for parameterType(int) and the attribution para to this block.
<remarks>
<para>The returned descriptor describes the parameter at <paramref name="i" />.</para>
</remarks>
docs/xml/Java.Lang.Invoke/ITypeDescriptor+IOfMethod.xml:401
- These member docs add new prose but omit the standard Android reference link + AOSP/CC BY attribution paragraphs used elsewhere in this file (e.g., ParameterCount/ParameterList). For consistency and licensing attribution, please add the reference link for returnType() and the attribution para to this block.
<remarks>
<para>The returned descriptor represents this method descriptor's return type.</para>
</remarks>
docs/xml/Java.Lang.Invoke/ITypeDescriptor+IOfMethod.xml:162
- These member docs add new prose but omit the standard Android reference link + AOSP/CC BY attribution paragraphs used elsewhere in this file (e.g., ParameterCount/ParameterList). For consistency and licensing attribution, please add the reference link for dropParameterTypes(...) and the attribution para to this block.
<remarks>
<para>The removed range starts at <paramref name="start" /> and excludes <paramref name="end" />.</para>
</remarks>
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
|
@dalexsoto review |
dalexsoto
left a comment
dalexsoto
left a comment
There was a problem hiding this comment.
InsertParameterTypes now correctly documents insertion at pos and the append behavior when pos == ParameterCount(), with no remaining blocker.
Summary
Java.Lang.Invoke.ITypeDescriptor.IOfMethodoperations for changing and inspecting method descriptors.TypeDescriptor.OfMethodmembers, with no overlap with the merged lookup, call-site, var-handle, or reference-kind documentation PRs.Refs #201
Sources
Validation
docs/xml/Java.Lang.Invoke/ITypeDescriptor+IOfMethod.xmlwith PowerShell's XML parser.To be added.placeholders remain in the edited file; 420 remain in the partialJava.Lang.Invokescope.git diff --check.